Code frame and sourcemapped error support for Turbopack #56727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This implements support for properly tracing sourcemaps when presenting error stacks to the user. It also adds code frames when possible.
Tests Passed |
Stats from current PRDefault BuildGeneral Overall increase
|
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| buildDuration | 10.8s | 10.7s | N/A |
| buildDurationCached | 6.3s | 6.1s | N/A |
| nodeModulesSize | 174 MB | 174 MB | |
| nextStartRea..uration (ms) | 498ms | 500ms | N/A |
Client Bundles (main, webpack)
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| 199-HASH.js gzip | 27.5 kB | 27.5 kB | N/A |
| 3f784ff6-HASH.js gzip | 53.3 kB | 53.3 kB | ✓ |
| 99.HASH.js gzip | 182 B | 182 B | ✓ |
| framework-HASH.js gzip | 45.3 kB | 45.3 kB | ✓ |
| main-app-HASH.js gzip | 254 B | 251 B | N/A |
| main-HASH.js gzip | 32.9 kB | 32.9 kB | N/A |
| webpack-HASH.js gzip | 1.75 kB | 1.75 kB | N/A |
| Overall change | 98.8 kB | 98.8 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
| Overall change | 31 kB | 31 kB | ✓ |
Client Pages
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 206 B | 205 B | N/A |
| _error-HASH.js gzip | 182 B | 180 B | N/A |
| amp-HASH.js gzip | 506 B | 505 B | N/A |
| css-HASH.js gzip | 322 B | 323 B | N/A |
| dynamic-HASH.js gzip | 2.57 kB | 2.57 kB | N/A |
| edge-ssr-HASH.js gzip | 260 B | 259 B | N/A |
| head-HASH.js gzip | 350 B | 350 B | ✓ |
| hooks-HASH.js gzip | 369 B | 369 B | ✓ |
| image-HASH.js gzip | 4.36 kB | 4.36 kB | N/A |
| index-HASH.js gzip | 256 B | 256 B | ✓ |
| link-HASH.js gzip | 2.64 kB | 2.63 kB | N/A |
| routerDirect..HASH.js gzip | 312 B | 311 B | N/A |
| script-HASH.js gzip | 385 B | 384 B | N/A |
| withRouter-HASH.js gzip | 307 B | 308 B | N/A |
| 1afbb74e6ecf..834.css gzip | 106 B | 106 B | ✓ |
| Overall change | 1.08 kB | 1.08 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 484 B | 482 B | N/A |
| Overall change | 0 B | 0 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| index.html gzip | 528 B | 530 B | N/A |
| link.html gzip | 541 B | 542 B | N/A |
| withRouter.html gzip | 523 B | 524 B | N/A |
| Overall change | 0 B | 0 B | ✓ |
Edge SSR bundle Size
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| edge-ssr.js gzip | 93.7 kB | 93.7 kB | N/A |
| page.js gzip | 155 kB | 155 kB | N/A |
| Overall change | 0 B | 0 B | ✓ |
Middleware size
| vercel/next.js canary | vercel/next.js wbinnssmith/codeframe | Change | |
|---|---|---|---|
| middleware-b..fest.js gzip | 623 B | 623 B | ✓ |
| middleware-r..fest.js gzip | 150 B | 151 B | N/A |
| middleware.js gzip | 22.5 kB | 22.5 kB | N/A |
| edge-runtime..pack.js gzip | 1.92 kB | 1.92 kB | ✓ |
| Overall change | 2.55 kB | 2.55 kB | ✓ |
…rbopack" This reverts commit d70a8f6.
wbinnssmith
requested review from
timneutkens,
ijjk,
shuding,
huozhi,
a team,
feedthejim,
ztanner and
wyattjoh
as code owners
wbinnssmith
changed the title
wbinnssmith
commented
Oct 17, 2023
| import { codeFrameColumns } from '@babel/code-frame' | ||
| import { launchEditor } from './internal/helpers/launchEditor' | ||
|
|
||
| interface Project { |
There was a problem hiding this comment.
Not sure how to import these from the next package since that depends on this package...
jridgewell
reviewed
Oct 17, 2023
| bail!("Expected token to be an OriginalToken") | ||
| }; | ||
|
|
||
| let Some(source_file) = token.original_file.strip_prefix("/turbopack/[project]/") |
There was a problem hiding this comment.
Can this be derived form somewhere from wherever has these names set, instead of us hardcoding again?
| line: token.original_line as u32, | ||
| column: Some(token.original_column as u32), | ||
| }, | ||
| source, |
There was a problem hiding this comment.
This can be an extremely large file, do we need to pass this along? Can we return just a code frame?
There was a problem hiding this comment.
We'd have to reimplement creating code frames in Rust. Maybe a followup?
There was a problem hiding this comment.
Can we batch multiple calls so that we're not constantly passing the same source string back for a trace that has multiple frames pointing to the same file?
jridgewell
previously approved these changes
Oct 19, 2023
| if (!sourcePromise) { | ||
| sourcePromise = new Promise((resolve) => | ||
| // Batch reading sources content as this can be quite large, and stacks often reference the same files | ||
| setTimeout(resolve, 100) |
There was a problem hiding this comment.
I think we could change this to immediately execute, and keep in in memory for 100ms after it resolves? That way we don't add a 100ms delay to the actual tracing.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements support for properly tracing sourcemaps when presenting error stacks to the user. It also adds code frames when possible.
Closes WEB-1764